Serviceability Check API:
Description: Checks courier availability for pickup and delivery pincodes.
Basic Information
| NAME | DETAILS |
|---|---|
| Usage: | Mandatory |
| URL: | https://api.rapidshyp.com/rapidshyp/apis/v1/b2b/orders/b2b_serviceabilty_check |
| Request Type: | POST |
| Scheme: | HTTPS |
| Header (content-type): | application/json |
| Header (rapidshyp-token): | API-Key |
Curl
curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/b2b/orders/b2b_serviceabilty_check' \
--header 'rapidshyp-token: YOUR_TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data '{
"pickup_pincode": "122003",
"delivery_pincode": "122003",
"cod": true,
"is_to_pay": false,
"is_appointment_based_delivery": false,
"total_order_value": 10000,
"is_csd": true,
"dod": false,
"is_malldelivery": false,
"box_details": [
{
"number_of_boxes": 1,
"dead_weight_per_box": 10,
"length": 1,
"breadth": 1,
"height": 1
}
]
}'
Request Parameters:
| Parameter | Required | Remark | Validation |
|---|---|---|---|
| pickup_pincode | Yes | Pickup pincode | 6 digits |
| delivery_pincode | Yes | Delivery pincode | 6 digits |
| cod | Yes | COD flag | true/false |
| is_to_pay | Yes | To-Pay shipment flag | true/false |
| is_appointment_based_delivery | Yes | Appointment based delivery flag | true/false |
| total_order_value | Yes | Order value | Numeric |
| is_csd | Yes | CSD (Canteen Stores Department) flag | true/false |
| dod | Yes | Draft on Delivery flag | true/false |
| is_malldelivery | Yes | Mall delivery flag | true/false |
| box_details.number_of_boxes | Yes | Number of boxes | Integer (>0) |
| box_details.dead_weight_per_box | Yes | Weight per box (kg) | Numeric (>0) |
| box_details.length | Yes | Length of box | Numeric (>0) |
| box_details.breadth | Yes | Breadth of box | Numeric (>0) |
| box_details.height | Yes | Height of box | Numeric (>0) |
Response:
JSON
{
"status": true,
"remark": "Success",
"serviceable_courier_list": [
{
"courier_code": "789",
"courier_name": "Om Logistics Express B2B",
"parent_courier_name": "OM LOGISTICS",
"cutoff_time": "13:00",
"freight_mode": "Surface",
"max_shipment_weight": 1500000.0,
"min_shipment_weight": 50000.0,
"total_freight": 4970.75,
"edd": "22-04-2026"
},
{
"courier_code": "456",
"courier_name": "Om Logistics B2B",
"parent_courier_name": "OM LOGISTICS",
"cutoff_time": "13:00",
"freight_mode": "Surface",
"max_shipment_weight": 7000000.0,
"min_shipment_weight": 5000.0,
"total_freight": 2645.56,
"edd": "24-04-2026"
},
{
"courier_code": "123",
"courier_name": "Om Logistics Air B2B",
"parent_courier_name": "OM LOGISTICS",
"cutoff_time": "13:00",
"freight_mode": "Air",
"max_shipment_weight": 1500000.0,
"min_shipment_weight": 5000.0,
"total_freight": 4224.4,
"edd": "22-04-2026"
}
]
}